/*
 * Copyright (c) 2011-2012 Alexander Dubu
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * o  Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * o  Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * o  Neither the name Axil nor the names of its contributors may be used to
 *    endorse or promote products derived from this software without specific
 *    prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package axil.stdlib.text.function;

import axil.api.AxilObject;
import axil.api.extend.Environment;
import axil.api.extend.Function;
import axil.api.extend.Parameters;
import axil.api.extend.Source;
import axil.stdlib.core.type.Bool;

import static axil.framework.Functions.*;


/**
 * Tell if the given string matches a formatting mask. For example, to match a
 * social security number:
 *
 * 		matches(text, "000-00-0000")
 *
 * The following characters are supported for the mask:
 *
 * 		0 - Any digit, including zero
 * 		9 - Any digit, but not zero
 * 		A - Any letter, must be uppercase
 * 		a - Any letter, must be lowercase
 * 		C - Any letter, can be upper or lowercase
 * 		X - Any letter or digit
 * 	    ? - Any character at all
 * 	    _ - any whitespace or punctuation character
 */
public class Matches implements Function {
	private boolean match(char ch, char mask) {
		switch(mask) {
		case '0':
			return Character.isDigit(ch);
		case '9':
			return (ch != '0') && Character.isDigit(ch);
		case 'A':
			return Character.isLetter(ch) && Character.isUpperCase(ch);
		case 'a':
			return Character.isLetter(ch) && Character.isLowerCase(ch);
		case 'C':
			return Character.isLetter(ch);
		case 'X':
			return Character.isLetterOrDigit(ch);
		case '?':
			return true;
		case '_':
			return Character.isWhitespace(ch);
		default:
			throw error(axil(), "invalid-mask-char", nv("char", mask));
		}
	}


	/**
	 * Execute this function with the given arguments. The Axil compiler will
	 * ensure that the number of arguments passed to the function are valid.
	 * If this function fails during execution for any reason, then an exception
	 * is thrown.
	 */
	public AxilObject eval(Environment env, Parameters params, Source source) {
		String text = params.a().toString();
		String mask = params.b().toString();
		final int size = text.length();
		if (size != mask.length()) {
			return Bool.FALSE;
		}
		for (int i = 0; i < size; i ++) {
			if (! match(text.charAt(i), mask.charAt(i))) {
				return Bool.FALSE;
			}
		}
		return Bool.TRUE;
	}
}
